blob: 798b551514a81549d1d9b31b5a8e079e521ba657 [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Junio C Hamano8f76dc62007-01-17 07:24:255the git command's behavior. `.git/config` file for each repository
6is used to store the information for that repository, and
7`$HOME/.gitconfig` is used to store per user information to give
Junio C Hamano79556902007-02-24 11:15:548fallback values for `.git/config` file. The file `/etc/gitconfig`
9can be used to store system-wide defaults.
Junio C Hamano8f76dc62007-01-17 07:24:2510
11They can be used by both the git plumbing
Junio C Hamanof1d14802006-06-08 00:48:1712and the porcelains. The variables are divided into sections, where
Junio C Hamano07824ce2006-04-25 07:36:5413in the fully qualified variable name the variable itself is the last
14dot-separated segment and the section name is everything before the last
15dot. The variable names are case-insensitive and only alphanumeric
16characters are allowed. Some variables may appear multiple times.
17
Junio C Hamanobee172f2007-01-23 08:44:1818Syntax
19~~~~~~
20
Junio C Hamano07824ce2006-04-25 07:36:5421The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1822ignored. The '#' and ';' characters begin comments to the end of line,
23blank lines are ignored.
24
25The file consists of sections and variables. A section begins with
26the name of the section in square brackets and continues until the next
27section begins. Section names are not case sensitive. Only alphanumeric
28characters, '`-`' and '`.`' are allowed in section names. Each variable
29must belong to some section, which means that there must be section
30header before first setting of a variable.
31
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
34in the section header, like in example below:
35
36--------
37[section "subsection"]
38
39--------
40
Junio C Hamanofa0d4cf2007-01-25 02:23:5841Subsection names can contain any characters except newline (doublequote
42'`"`' and backslash have to be escaped as '`\"`' and '`\\`',
Junio C Hamanoee1e4282007-02-04 08:32:0443respectively) and are case sensitive. Section header cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1844lines. Variables may belong directly to a section or to a given subsection.
45You can have `[section]` if you have `[section "subsection"]`, but you
46don't need to.
47
48There is also (case insensitive) alternative `[section.subsection]` syntax.
49In this syntax subsection names follow the same restrictions as for section
50name.
51
52All the other lines are recognized as setting variables, in the form
53'name = value'. If there is no equal sign on the line, the entire line
54is taken as 'name' and the variable is recognized as boolean "true".
55The variable names are case-insensitive and only alphanumeric
56characters and '`-`' are allowed. There can be more than one value
57for a given variable; we say then that variable is multivalued.
58
59Leading and trailing whitespace in a variable value is discarded.
60Internal whitespace within a variable value is retained verbatim.
61
62The values following the equals sign in variable assign are all either
63a string, an integer, or a boolean. Boolean values may be given as yes/no,
640/1 or true/false. Case is not significant in boolean values, when
65converting value to the canonical form using '--bool' type specifier;
Junio C Hamanoba4b9282008-07-06 05:20:3166'git-config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1867
68String values may be entirely or partially enclosed in double quotes.
69You need to enclose variable value in double quotes if you want to
70preserve leading or trailing whitespace, or if variable value contains
71beginning of comment characters (if it contains '#' or ';').
72Double quote '`"`' and backslash '`\`' characters in variable value must
73be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
74
75The following escape sequences (beside '`\"`' and '`\\`') are recognized:
76'`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB)
77and '`\b`' for backspace (BS). No other char escape sequence, nor octal
78char sequences are valid.
79
80Variable value ending in a '`\`' is continued on the next line in the
81customary UNIX fashion.
82
83Some variables may require special value format.
Junio C Hamano07824ce2006-04-25 07:36:5484
85Example
86~~~~~~~
87
88# Core variables
89[core]
90; Don't trust file modes
91filemode = false
92
93# Our diff algorithm
94[diff]
95external = "/usr/local/bin/gnu-diff -u"
96renames = true
97
Junio C Hamano52401ef2006-12-19 00:54:3898[branch "devel"]
99remote = origin
100merge = refs/heads/devel
101
Junio C Hamanobee172f2007-01-23 08:44:18102# Proxy settings
103[core]
Junio C Hamanoc71a8732007-08-04 00:27:26104gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18105gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38106
Junio C Hamano07824ce2006-04-25 07:36:54107Variables
108~~~~~~~~~
109
110Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17111For command-specific variables, you will find a more detailed description
112in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54113porcelain configuration variables in the respective porcelain documentation.
114
115core.fileMode::
116If false, the executable bit differences between the index and
117the working copy are ignored; useful on broken filesystems like FAT.
Junio C Hamano35738e82008-01-07 07:55:46118See linkgit:git-update-index[1]. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54119
Junio C Hamanod526ba92007-07-02 00:17:42120core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31121The commands that output paths (e.g. 'ls-files',
122'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42123"unusual" characters in the pathname by enclosing the
124pathname in a double-quote pair and with backslashes the
125same way strings in C source code are quoted. If this
126variable is set to false, the bytes higher than 0x80 are
127not quoted but output as verbatim. Note that double
128quote, backslash and control characters are always
129quoted without `-z` regardless of the setting of this
130variable.
131
Junio C Hamanod9e0e5d2007-04-14 16:22:04132core.autocrlf::
133If true, makes git convert `CRLF` at the end of lines in text files to
134`LF` when reading from the filesystem, and convert in reverse when
135writing to the filesystem. The variable can be set to
136'input', in which case the conversion happens only while
137reading from the filesystem but files are written out with
138`LF` at the end of lines. Currently, which paths to consider
139"text" (i.e. be subjected to the autocrlf mechanism) is
140decided purely based on the contents.
141
Junio C Hamano26e590a2008-02-17 03:53:51142core.safecrlf::
143If true, makes git check if converting `CRLF` as controlled by
144`core.autocrlf` is reversible. Git will verify if a command
145modifies a file in the work tree either directly or indirectly.
146For example, committing a file followed by checking out the
147same file should yield the original file in the work tree. If
148this is not the case for the current setting of
149`core.autocrlf`, git will reject the file. The variable can
150be set to "warn", in which case git will only warn about an
151irreversible conversion but continue the operation.
152+
153CRLF conversion bears a slight chance of corrupting data.
154autocrlf=true will convert CRLF to LF during commit and LF to
155CRLF during checkout. A file that contains a mixture of LF and
156CRLF before the commit cannot be recreated by git. For text
157files this is the right thing to do: it corrects line endings
158such that we have only LF line endings in the repository.
159But for binary files that are accidentally classified as text the
160conversion can corrupt data.
161+
162If you recognize such corruption early you can easily fix it by
163setting the conversion type explicitly in .gitattributes. Right
164after committing you still have the original file in your work
165tree and this file is not yet corrupted. You can explicitly tell
166git that this file is binary and git will handle the file
167appropriately.
168+
169Unfortunately, the desired effect of cleaning up text files with
170mixed line endings and the undesired effect of corrupting binary
171files cannot be distinguished. In both cases CRLFs are removed
172in an irreversible way. For text files this is the right thing
173to do because CRLFs are line endings, while for binary files
174converting CRLFs corrupts data.
175+
176Note, this safety check does not mean that a checkout will generate a
177file identical to the original file for a different setting of
178`core.autocrlf`, but only for the current one. For example, a text
179file with `LF` would be accepted with `core.autocrlf=input` and could
180later be checked out with `core.autocrlf=true`, in which case the
181resulting file would contain `CRLF`, although the original file
182contained `LF`. However, in both work trees the line endings would be
183consistent, that is either all `LF` or all `CRLF`, but never mixed. A
184file with mixed line endings would be reported by the `core.safecrlf`
185mechanism.
186
Junio C Hamanoaa83a7d2007-03-05 02:37:29187core.symlinks::
188If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46189contain the link text. linkgit:git-update-index[1] and
190linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29191file. Useful on filesystems like FAT that do not support
192symbolic links. True by default.
193
Junio C Hamano07824ce2006-04-25 07:36:54194core.gitProxy::
195A "proxy command" to execute (as 'command host port') instead
196of establishing direct connection to the remote server when
197using the git protocol for fetching. If the variable value is
198in the "COMMAND for DOMAIN" format, the command is applied only
199on hostnames ending with the specified domain string. This variable
200may be set multiple times and is matched in the given order;
201the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17202+
203Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
204(which always applies universally, without the special "for"
205handling).
Junio C Hamano07824ce2006-04-25 07:36:54206
207core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34208If true, commands which modify both the working tree and the index
209will mark the updated paths with the "assume unchanged" bit in the
210index. These marked files are then assumed to stay unchanged in the
211working copy, until you mark them otherwise manually - Git will not
212detect the file changes by lstat() calls. This is useful on systems
213where those are very slow, such as Microsoft Windows.
214See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54215False by default.
216
Junio C Hamano88a3a072006-05-04 08:01:43217core.preferSymlinkRefs::
218Instead of the default "symref" format for HEAD
219and other symbolic reference files, use symbolic links.
220This is sometimes needed to work with old scripts that
221expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54222
Junio C Hamano1025e752007-02-23 07:21:26223core.bare::
224If true this repository is assumed to be 'bare' and has no
225working directory associated with it. If this is the case a
226number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46227disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26228+
Junio C Hamano35738e82008-01-07 07:55:46229This setting is automatically guessed by linkgit:git-clone[1] or
230linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26231repository that ends in "/.git" is assumed to be not bare (bare =
232false), while all other repositories are assumed to be bare (bare
233= true).
234
Junio C Hamanod526ba92007-07-02 00:17:42235core.worktree::
236Set the path to the working tree. The value will not be
237used in combination with repositories found automatically in
238a .git directory (i.e. $GIT_DIR is not set).
Junio C Hamano764a6672007-10-23 01:23:31239This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano7d575a52008-04-30 08:45:27240variable and the '--work-tree' command line option. It can be
241a absolute path or relative path to the directory specified by
242--git-dir or GIT_DIR.
243Note: If --git-dir or GIT_DIR are specified but none of
244--work-tree, GIT_WORK_TREE and core.worktree is specified,
245the current working directory is regarded as the top directory
246of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42247
Junio C Hamano341071d2006-06-04 07:24:48248core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49249Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48250"$GIT_DIR/logs/<ref>", by appending the new and old
251SHA1, the date/time and the reason of the update, but
252only when the file exists. If this configuration
253variable is set to true, missing "$GIT_DIR/logs/<ref>"
254file is automatically created for branch heads.
Junio C Hamano1caaf472006-12-31 08:29:35255+
256This information can be used to determine what commit
257was the tip of a branch "2 days ago".
258+
259This value is true by default in a repository that has
260a working directory associated with it, and false by
261default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48262
Junio C Hamano07824ce2006-04-25 07:36:54263core.repositoryFormatVersion::
264Internal variable identifying the repository format and layout
265version.
266
267core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42268When 'group' (or 'true'), the repository is made shareable between
269several users in a group (making sure all the files and objects are
270group-writable). When 'all' (or 'world' or 'everybody'), the
271repository will be readable by all users, additionally to being
272group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37273reported by umask(2). When '0xxx', where '0xxx' is an octal number,
274files in the repository will have this mode value. '0xxx' will override
275user's umask value, and thus, users with a safe umask (0077) can use
276this option. Examples: '0660' is equivalent to 'group'. '0640' is a
277repository that is group-readable but not group-writable.
278See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54279
280core.warnAmbiguousRefs::
281If true, git will warn you if the ref name you passed it is ambiguous
282and might match multiple refs in the .git/refs/ tree. True by default.
283
Junio C Hamano7ec15722006-07-07 02:03:59284core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09285An integer -1..9, indicating a default compression level.
286-1 is the zlib default. 0 means no compression,
287and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42288If set, this provides a default to other compression variables,
289such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26290
Junio C Hamanof2ce2972007-05-20 19:12:09291core.loosecompression::
292An integer -1..9, indicating the compression level for objects that
293are not in a pack file. -1 is the zlib default. 0 means no
294compression, and 1..9 are various speed/size tradeoffs, 9 being
295slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42296not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49297
Junio C Hamanofc4d38c2007-01-08 06:53:32298core.packedGitWindowSize::
299Number of bytes of a pack file to map into memory in a
300single mapping operation. Larger window sizes may allow
301your system to process a smaller number of large pack files
302more quickly. Smaller window sizes will negatively affect
303performance due to increased calls to the operating system's
304memory manager, but may improve performance when accessing
305a large number of large pack files.
306+
307Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
308MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
309be reasonable for all users/operating systems. You probably do
310not need to adjust this value.
311+
312Common unit suffixes of 'k', 'm', or 'g' are supported.
313
314core.packedGitLimit::
315Maximum number of bytes to map simultaneously into memory
316from pack files. If Git needs to access more than this many
317bytes at once to complete an operation it will unmap existing
318regions to reclaim virtual address space within the process.
319+
320Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
321This should be reasonable for all users/operating systems, except on
322the largest projects. You probably do not need to adjust this value.
323+
324Common unit suffixes of 'k', 'm', or 'g' are supported.
325
Junio C Hamanob8c51282007-03-19 10:43:30326core.deltaBaseCacheLimit::
327Maximum number of bytes to reserve for caching base objects
328that multiple deltafied objects reference. By storing the
329entire decompressed base objects in a cache Git is able
330to avoid unpacking and decompressing frequently used base
331objects multiple times.
332+
333Default is 16 MiB on all platforms. This should be reasonable
334for all users/operating systems, except on the largest projects.
335You probably do not need to adjust this value.
336+
337Common unit suffixes of 'k', 'm', or 'g' are supported.
338
Junio C Hamano1d90cb02007-07-03 07:05:31339core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37340In addition to '.gitignore' (per-directory) and
341'.git/info/exclude', git looks into this file for patterns
Junio C Hamano679d22d2007-06-02 21:13:44342of files which are not meant to be tracked. See
Junio C Hamano35738e82008-01-07 07:55:46343linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37344
Junio C Hamanof6002a92007-07-20 10:28:22345core.editor::
346Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27347messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22348variable when it is set, and the environment variable
349`GIT_EDITOR` is not set. The order of preference is
Junio C Hamanode9879a2007-07-22 09:33:42350`GIT_EDITOR` environment, `core.editor`, `VISUAL` and
351`EDITOR` environment variables and then finally `vi`.
Junio C Hamanof6002a92007-07-20 10:28:22352
Junio C Hamano28d8ede2007-07-05 05:51:38353core.pager::
354The command that git will use to paginate output. Can be overridden
355with the `GIT_PAGER` environment variable.
356
Junio C Hamano942b35e2007-12-09 10:19:33357core.whitespace::
358A comma separated list of common whitespace problems to
Junio C Hamanoba4b9282008-07-06 05:20:31359notice. 'git-diff' will use `color.diff.whitespace` to
360highlight them, and 'git-apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59361consider them as errors. You can prefix `-` to disable
362any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33363+
364* `trailing-space` treats trailing whitespaces at the end of the line
365 as an error (enabled by default).
366* `space-before-tab` treats a space character that appears immediately
367 before a tab character in the initial indent part of the line as an
368 error (enabled by default).
369* `indent-with-non-tab` treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42370 space characters as an error (not enabled by default).
Junio C Hamano601f3e52008-02-25 08:40:42371* `cr-at-eol` treats a carriage-return at the end of line as
372 part of the line terminator, i.e. with it, `trailing-space`
373 does not trigger if the character before such a carriage-return
374 is not a whitespace (not enabled by default).
Junio C Hamano942b35e2007-12-09 10:19:33375
Junio C Hamano9eb57532008-06-26 06:33:46376core.fsyncobjectfiles::
377This boolean will enable 'fsync()' when writing object files.
378+
379This is a total waste of time and effort on a filesystem that orders
380data writes properly, but can be useful for filesystems that do not use
381journalling (traditional UNIX filesystems) or that only journal metadata
382and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
383
Junio C Hamano33db4372006-06-07 19:51:45384alias.*::
Junio C Hamano35738e82008-01-07 07:55:46385Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45386after defining "alias.last = cat-file commit HEAD", the invocation
387"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17388confusion and troubles with script usage, aliases that
389hide existing git commands are ignored. Arguments are split by
390spaces, the usual shell quoting and escaping is supported.
391quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39392+
393If the alias expansion is prefixed with an exclamation point,
394it will be treated as a shell command. For example, defining
395"alias.new = !gitk --all --not ORIG_HEAD", the invocation
396"git new" is equivalent to running the shell command
397"gitk --all --not ORIG_HEAD".
Junio C Hamano9cb74f22007-02-12 04:15:05398
Junio C Hamano07824ce2006-04-25 07:36:54399apply.whitespace::
Junio C Hamanoba4b9282008-07-06 05:20:31400Tells 'git-apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46401as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54402
Junio C Hamano7fd84172007-05-24 07:00:32403branch.autosetupmerge::
Junio C Hamanoba4b9282008-07-06 05:20:31404Tells 'git-branch' and 'git-checkout' to setup new branches
Junio C Hamano24bc09a2008-02-28 00:27:44405so that linkgit:git-pull[1] will appropriately merge from the
406starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32407this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44408and `--no-track` options. The valid settings are: `false` -- no
409automatic setup is done; `true` -- automatic setup is done when the
410starting point is a remote branch; `always` -- automatic setup is
411done when the starting point is either a local branch or remote
412branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32413
Junio C Hamano869bb802008-05-12 00:29:47414branch.autosetuprebase::
Junio C Hamanoba4b9282008-07-06 05:20:31415When a new branch is created with 'git-branch' or 'git-checkout'
Junio C Hamano869bb802008-05-12 00:29:47416that tracks another branch, this variable tells git to set
417up pull to rebase instead of merge (see "branch.<name>.rebase").
418When `never`, rebase is never automatically set to true.
419When `local`, rebase is set to true for tracked branches of
420other local branches.
421When `remote`, rebase is set to true for tracked branches of
422remote branches.
423When `always`, rebase will be set to true for all tracking
424branches.
425See "branch.autosetupmerge" for details on how to set up a
426branch to track another branch.
427This option defaults to never.
428
Junio C Hamano47c1e3c2006-09-25 04:45:55429branch.<name>.remote::
Junio C Hamanoba4b9282008-07-06 05:20:31430When in branch <name>, it tells 'git-fetch' which remote to fetch.
431If this option is not given, 'git-fetch' defaults to remote "origin".
Junio C Hamano47c1e3c2006-09-25 04:45:55432
433branch.<name>.merge::
Junio C Hamanoba4b9282008-07-06 05:20:31434When in branch <name>, it tells 'git-fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31435refspec to be marked for merging in FETCH_HEAD. The value is
436handled like the remote part of a refspec, and must match a
437ref which is fetched from the remote given by
438"branch.<name>.remote".
Junio C Hamanoba4b9282008-07-06 05:20:31439The merge information is used by 'git-pull' (which at first calls
440'git-fetch') to lookup the default branch for merging. Without
441this option, 'git-pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46442Specify multiple values to get an octopus merge.
Junio C Hamanoba4b9282008-07-06 05:20:31443If you wish to setup 'git-pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07444another branch in the local repository, you can point
445branch.<name>.merge to the desired branch, and use the special setting
446`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55447
Junio C Hamano1b50ce92007-10-03 12:05:53448branch.<name>.mergeoptions::
449Sets default options for merging into branch <name>. The syntax and
Junio C Hamano35738e82008-01-07 07:55:46450supported options are equal to that of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53451option values containing whitespace characters are currently not
452supported.
453
Junio C Hamano0c999702007-12-03 09:57:55454branch.<name>.rebase::
455When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08456instead of merging the default branch from the default remote when
457"git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55458*NOTE*: this is a possibly dangerous operation; do *not* use
Junio C Hamano35738e82008-01-07 07:55:46459it unless you understand the implications (see linkgit:git-rebase[1]
Junio C Hamano0c999702007-12-03 09:57:55460for details).
461
Junio C Hamano8760ea62008-03-14 08:58:45462browser.<tool>.cmd::
463Specify the command to invoke the specified browser. The
464specified command is evaluated in shell with the URLs passed
465as arguments. (See linkgit:git-web--browse[1].)
466
Junio C Hamanoe35a6fc2008-01-29 09:46:27467browser.<tool>.path::
468Override the path for the given tool that may be used to
469browse HTML help (see '-w' option in linkgit:git-help[1]) or a
470working repository in gitweb (see linkgit:git-instaweb[1]).
471
Junio C Hamano47b9acd2007-04-24 07:34:34472clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45473A boolean to make git-clean do nothing unless given -f
474or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34475
Junio C Hamanoeb692952007-01-03 22:02:12476color.branch::
477A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46478linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21479`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12480only when the output is to a terminal. Defaults to false.
481
482color.branch.<slot>::
483Use customized color for branch coloration. `<slot>` is one of
484`current` (the current branch), `local` (a local branch),
485`remote` (a tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22486refs).
487+
488The value for these configuration variables is a list of colors (at most
489two) and attributes (at most one), separated by spaces. The colors
490accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
491`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
492`blink` and `reverse`. The first color given is the foreground; the
493second is the background. The position of the attribute, if any,
494doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12495
Junio C Hamano3f403b02006-12-13 10:14:13496color.diff::
Junio C Hamano0fc8cd92007-12-06 03:26:21497When set to `always`, always use colors in patch.
498When false (or `never`), never. When set to `true` or `auto`, use
499colors only when the output is to the terminal. Defaults to false.
Junio C Hamano9ae1a062006-07-10 08:12:34500
Junio C Hamano3f403b02006-12-13 10:14:13501color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22502Use customized color for diff colorization. `<slot>` specifies
503which part of the patch to use the specified color, and is one
504of `plain` (context text), `meta` (metainformation), `frag`
505(hunk header), `old` (removed lines), `new` (added lines),
Junio C Hamano942b35e2007-12-09 10:19:33506`commit` (commit headers), or `whitespace` (highlighting
507whitespace errors). The values of these variables may be specified as
Junio C Hamano5a702332007-01-28 20:55:22508in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34509
Junio C Hamano00b8b632007-12-07 09:50:49510color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46511When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31512and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49513When false (or `never`), never. When set to `true` or `auto`, use
514colors only when the output is to the terminal. Defaults to false.
515
516color.interactive.<slot>::
Junio C Hamanoba4b9282008-07-06 05:20:31517Use customized color for 'git-add --interactive'
Junio C Hamano00b8b632007-12-07 09:50:49518output. `<slot>` may be `prompt`, `header`, or `help`, for
519three distinct types of normal output from interactive
520programs. The values of these variables may be specified as
521in color.branch.<slot>.
522
Junio C Hamanoe7935c42006-12-13 21:32:17523color.pager::
524A boolean to enable/disable colored output when the pager is in
525use (default is true).
526
527color.status::
528A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46529linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21530`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17531only when the output is to a terminal. Defaults to false.
532
533color.status.<slot>::
534Use customized color for status colorization. `<slot>` is
535one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04536`added` or `updated` (files which are added but not committed),
537`changed` (files which are changed but not added in the index),
Junio C Hamanob713ff12008-05-24 01:12:30538`untracked` (files which are not tracked by git), or
539`nobranch` (the color the 'no branch' warning is shown in, defaulting
540to red). The values of these variables may be specified as in
541color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17542
Junio C Hamanob968dbb2007-07-27 07:26:40543commit.template::
544Specify a file to use as the template for new commit messages.
545
Junio C Hamano83d46a22008-02-21 02:29:42546color.ui::
547When set to `always`, always use colors in all git commands which
548are capable of colored output. When false (or `never`), never. When
549set to `true` or `auto`, use colors only when the output is to the
550terminal. When more specific variables of color.* are set, they always
551take precedence over this setting. Defaults to false.
552
Junio C Hamanodbb64592007-09-01 11:17:39553diff.autorefreshindex::
Junio C Hamanoba4b9282008-07-06 05:20:31554When using 'git-diff' to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39555files, do not consider stat-only change as changed.
556Instead, silently run `git update-index --refresh` to
557update the cached stat information for paths whose
558contents in the work tree match the contents in the
559index. This option defaults to true. Note that this
Junio C Hamanoba4b9282008-07-06 05:20:31560affects only 'git-diff' Porcelain, and not lower level
561'diff' commands, such as 'git-diff-files'.
Junio C Hamanodbb64592007-09-01 11:17:39562
Junio C Hamano1fbbbc12007-12-18 07:01:27563diff.external::
564If this config variable is set, diff generation is not
565performed using the internal diff machinery, but using the
566given command. Note: if you want to use an external diff
567program only on a subset of your files, you might want to
Junio C Hamano35738e82008-01-07 07:55:46568use linkgit:gitattributes[5] instead.
Junio C Hamano1fbbbc12007-12-18 07:01:27569
Junio C Hamano07824ce2006-04-25 07:36:54570diff.renameLimit::
571The number of files to consider when performing the copy/rename
Junio C Hamanoba4b9282008-07-06 05:20:31572detection; equivalent to the 'git-diff' option '-l'.
Junio C Hamano07824ce2006-04-25 07:36:54573
Junio C Hamano9ae1a062006-07-10 08:12:34574diff.renames::
575Tells git to detect renames. If set to any boolean value, it
576will enable basic rename detection. If set to "copies" or
577"copy", it will detect copies, as well.
578
Junio C Hamano54ea8d32007-01-25 07:59:48579fetch.unpackLimit::
580If the number of objects fetched over the git native
581transfer is below this
582limit, then the objects will be unpacked into loose object
583files. However if the number of received objects equals or
584exceeds this limit then the received pack will be stored as
585a pack, after adding any missing delta bases. Storing the
586pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17587especially on slow filesystems. If not set, the value of
588`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48589
Junio C Hamano8c5802d2007-11-15 00:13:36590format.numbered::
591A boolean which can enable sequence numbers in patch subjects.
Junio C Hamanofe986052007-12-19 07:33:38592Setting this option to "auto" will enable it only if there is
Junio C Hamano8c5802d2007-11-15 00:13:36593more than one patch. See --numbered option in
Junio C Hamano35738e82008-01-07 07:55:46594linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:36595
Junio C Hamano07824ce2006-04-25 07:36:54596format.headers::
597Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:46598by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:54599
Junio C Hamanod4c8e112007-03-04 10:32:38600format.suffix::
601The default for format-patch is to output files with the suffix
602`.patch`. Use this variable to change that suffix (make sure to
603include the dot if you want it).
604
Junio C Hamano86bcccc2008-03-08 09:33:55605format.pretty::
606The default pretty format for log/show/whatchanged command,
607See linkgit:git-log[1], linkgit:git-show[1],
608linkgit:git-whatchanged[1].
609
Junio C Hamanof2ce2972007-05-20 19:12:09610gc.aggressiveWindow::
611The window size parameter used in the delta compression
Junio C Hamanoba4b9282008-07-06 05:20:31612algorithm used by 'git-gc --aggressive'. This defaults
Junio C Hamanof2ce2972007-05-20 19:12:09613to 10.
614
Junio C Hamano1b50ce92007-10-03 12:05:53615gc.auto::
616When there are approximately more than this many loose
617objects in the repository, `git gc --auto` will pack them.
618Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17619light-weight garbage collection from time to time. The
620default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53621
622gc.autopacklimit::
623When there are more than this many packs that are not
624marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:17625--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37626default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53627
Junio C Hamano9d52e572007-02-13 23:48:20628gc.packrefs::
Junio C Hamanoba4b9282008-07-06 05:20:31629'git-gc' does not run `git pack-refs` in a bare repository by
Junio C Hamano9d52e572007-02-13 23:48:20630default so that older dumb-transport clients can still fetch
Junio C Hamanoba4b9282008-07-06 05:20:31631from the repository. Setting this to `true` lets 'git-gc'
632to run `git pack-refs`. Setting this to `false` tells
633'git-gc' never to run `git pack-refs`. The default setting is
Junio C Hamano9d52e572007-02-13 23:48:20634`notbare`. Enable it only when you know you do not have to
635support such clients. The default setting will change to `true`
636at some stage, and setting this to `false` will continue to
Junio C Hamanoba4b9282008-07-06 05:20:31637prevent `git pack-refs` from being run from 'git-gc'.
Junio C Hamano9d52e572007-02-13 23:48:20638
Junio C Hamano09a926d2008-03-13 07:55:29639gc.pruneexpire::
Junio C Hamanoba4b9282008-07-06 05:20:31640When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamano09a926d2008-03-13 07:55:29641Override the grace period with this config variable.
642
Junio C Hamano74640642006-12-27 10:59:55643gc.reflogexpire::
Junio C Hamanoba4b9282008-07-06 05:20:31644'git-reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55645this time; defaults to 90 days.
646
647gc.reflogexpireunreachable::
Junio C Hamanoba4b9282008-07-06 05:20:31648'git-reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55649this time and are not reachable from the current tip;
650defaults to 30 days.
651
652gc.rerereresolved::
653Records of conflicted merge you resolved earlier are
Junio C Hamanoba4b9282008-07-06 05:20:31654kept for this many days when 'git-rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46655The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55656
657gc.rerereunresolved::
658Records of conflicted merge you have not resolved are
Junio C Hamanoba4b9282008-07-06 05:20:31659kept for this many days when 'git-rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46660The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55661
Junio C Hamano15048272008-07-07 22:10:48662rerere.autoupdate::
663When set to true, `git-rerere` updates the index with the
664resulting contents after it cleanly resolves conflicts using
665previously recorded resolution. Defaults to false.
666
Junio C Hamano7a4a2832007-07-07 21:53:22667rerere.enabled::
668Activate recording of resolved conflicts, so that identical
669conflict hunks can be resolved automatically, should they
Junio C Hamano35738e82008-01-07 07:55:46670be encountered again. linkgit:git-rerere[1] command is by
Junio C Hamano0e47b232008-01-15 08:31:10671default enabled if you create `rr-cache` directory under
672`$GIT_DIR`, but can be disabled by setting this option to false.
Junio C Hamano7a4a2832007-07-07 21:53:22673
Junio C Hamano07824ce2006-04-25 07:36:54674gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:27675Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:46676See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54677
678gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:27679Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:46680various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54681
Junio C Hamanodfccbb02008-05-26 01:16:14682gitcvs.usecrlfattr
683If true, the server will look up the `crlf` attribute for
684files to determine the '-k' modes to use. If `crlf` is set,
685the '-k' mode will be left blank, so cvs clients will
686treat it as text. If `crlf` is explicitly unset, the file
687will be set with '-kb' mode, which supresses any newline munging
688the client might otherwise do. If `crlf` is not specified,
Junio C Hamanod32738e2008-07-09 19:53:42689then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:14690
Junio C Hamanod9e0e5d2007-04-14 16:22:04691gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:14692This is used if 'gitcvs.usecrlfattr' does not resolve
693the correct '-kb' mode to use. If true, all
694unresolved files are sent to the client in
695mode '-kb'. This causes the client to treat them
696as binary files, which suppresses any newline munging it
697otherwise might do. Alternatively, if it is set to "guess",
698then the contents of the file are examined to decide if
699it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:04700
701gitcvs.dbname::
702Database used by git-cvsserver to cache revision information
703derived from the git repository. The exact meaning depends on the
704used database driver, for SQLite (which is the default driver) this
705is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46706linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:04707Default: '%Ggitcvs.%m.sqlite'
708
709gitcvs.dbdriver::
710Used Perl DBI driver. You can specify any available driver
711 for this here, but it might not work. git-cvsserver is tested
712with 'DBD::SQLite', reported to work with 'DBD::Pg', and
713reported *not* to work with 'DBD::mysql'. Experimental feature.
714May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:46715See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:04716
Junio C Hamanoa2ad99e2007-04-18 09:57:04717gitcvs.dbuser, gitcvs.dbpass::
718Database user and password. Only useful if setting 'gitcvs.dbdriver',
719since SQLite has no concept of database users and/or passwords.
720'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46721linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:04722
Junio C Hamanoa74efce2008-04-02 08:39:08723gitcvs.dbTableNamePrefix::
724Database table name prefix. Prepended to the names of any
725database tables used, allowing a single database to be used
726for several repositories. Supports variable substitution (see
727linkgit:git-cvsserver[1] for details). Any non-alphabetic
728characters will be replaced with underscores.
729
Junio C Hamanodfccbb02008-05-26 01:16:14730All gitcvs variables except for 'gitcvs.usecrlfattr' and
731'gitcvs.allbinary' can also be specified as
732'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:27733is one of "ext" and "pserver") to make them apply only for the given
734access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:04735
Junio C Hamano6d76d612008-05-09 05:46:08736gui.commitmsgwidth::
737Defines how wide the commit message window is in the
738linkgit:git-gui[1]. "75" is the default.
739
740gui.diffcontext::
741Specifies how many context lines should be used in calls to diff
742made by the linkgit:git-gui[1]. The default is "5".
743
744gui.matchtrackingbranch::
745Determines if new branches created with linkgit:git-gui[1] should
746default to tracking remote branches with matching names or
747not. Default: "false".
748
749gui.newbranchtemplate::
750Is used as suggested name when creating new branches using the
751linkgit:git-gui[1].
752
753gui.pruneduringfetch::
754"true" if linkgit:git-gui[1] should prune tracking branches when
755performing a fetch. The default value is "false".
756
757gui.trustmtime::
758Determines if linkgit:git-gui[1] should trust the file modification
759timestamp or not. By default the timestamps are not trusted.
760
761gui.spellingdictionary::
762Specifies the dictionary used for spell checking commit messages in
763the linkgit:git-gui[1]. When set to "none" spell checking is turned
764off.
765
Junio C Hamano4e272312008-01-08 09:13:21766help.browser::
767Specify the browser that will be used to display help in the
768'web' format. See linkgit:git-help[1].
769
770help.format::
771Override the default help format used by linkgit:git-help[1].
772Values 'man', 'info', 'web' and 'html' are supported. 'man' is
773the default. 'web' and 'html' are the same.
774
Junio C Hamano58256872007-12-04 08:31:13775http.proxy::
776Override the HTTP proxy, normally configured using the 'http_proxy'
Junio C Hamano35738e82008-01-07 07:55:46777environment variable (see linkgit:curl[1]). This can be overridden
Junio C Hamano58256872007-12-04 08:31:13778on a per-remote basis; see remote.<name>.proxy
779
Junio C Hamano07824ce2006-04-25 07:36:54780http.sslVerify::
781Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45782over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:54783variable.
784
785http.sslCert::
786File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45787over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:54788variable.
789
790http.sslKey::
791File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:48792over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:54793variable.
794
795http.sslCAInfo::
796File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:48797fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:54798'GIT_SSL_CAINFO' environment variable.
799
800http.sslCAPath::
801Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:45802with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54803by the 'GIT_SSL_CAPATH' environment variable.
804
805http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:48806How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54807by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
808
809http.lowSpeedLimit, http.lowSpeedTime::
810If the HTTP transfer speed is less than 'http.lowSpeedLimit'
811for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:48812Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:54813'GIT_HTTP_LOW_SPEED_TIME' environment variables.
814
Junio C Hamanof1dcdfe2006-09-29 08:10:51815http.noEPSV::
816A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:04817This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:51818support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
819environment variable. Default is false (curl will use EPSV).
820
Junio C Hamano07824ce2006-04-25 07:36:54821i18n.commitEncoding::
822Character encoding the commit messages are stored in; git itself
823does not care per se, but this information is necessary e.g. when
824importing commits from emails or in the gitk graphical history
825browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:46826porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:54827
Junio C Hamano51f92e22006-12-29 05:18:28828i18n.logOutputEncoding::
829Character encoding the commit messages are converted to when
Junio C Hamanoba4b9282008-07-06 05:20:31830running 'git-log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:28831
Junio C Hamano4e272312008-01-08 09:13:21832instaweb.browser::
833Specify the program that will be used to browse your working
834repository in gitweb. See linkgit:git-instaweb[1].
835
836instaweb.httpd::
837The HTTP daemon command-line to start gitweb on your working
838repository. See linkgit:git-instaweb[1].
839
840instaweb.local::
841If true the web server started by linkgit:git-instaweb[1] will
842be bound to the local IP (127.0.0.1).
843
844instaweb.modulepath::
845The module path for an apache httpd used by linkgit:git-instaweb[1].
846
847instaweb.port::
848The port number to bind the gitweb httpd to. See
849linkgit:git-instaweb[1].
850
Junio C Hamanob713ff12008-05-24 01:12:30851log.date::
852Set default date-time mode for the log command. Setting log.date
Junio C Hamanoba4b9282008-07-06 05:20:31853value is similar to using 'git-log'\'s --date option. The value is one of the
Junio C Hamanob713ff12008-05-24 01:12:30854following alternatives: {relative,local,default,iso,rfc,short}.
855See linkgit:git-log[1].
856
Junio C Hamanofe9acab2006-11-24 12:10:55857log.showroot::
858If true, the initial commit will be shown as a big creation event.
859This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:46860Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:55861normally hide the root commit will now show it. True by default.
862
Junio C Hamano8b588d52008-03-15 09:48:37863man.viewer::
864Specify the programs that may be used to display help in the
865'man' format. See linkgit:git-help[1].
866
Junio C Hamano6d76d612008-05-09 05:46:08867include::merge-config.txt[]
Junio C Hamano07824ce2006-04-25 07:36:54868
Junio C Hamano6d76d612008-05-09 05:46:08869man.<tool>.cmd::
870Specify the command to invoke the specified man viewer. The
871specified command is evaluated in shell with the man page
872passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:26873
Junio C Hamano6d76d612008-05-09 05:46:08874man.<tool>.path::
875Override the path for the given tool that may be used to
876display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:13877
Junio C Hamano1fbbbc12007-12-18 07:01:27878mergetool.<tool>.path::
879Override the path for the given tool. This is useful in case
880your tool is not in the PATH.
881
Junio C Hamano86bcccc2008-03-08 09:33:55882mergetool.<tool>.cmd::
883Specify the command to invoke the specified merge tool. The
884specified command is evaluated in shell with the following
885variables available: 'BASE' is the name of a temporary file
886containing the common base of the files to be merged, if available;
887'LOCAL' is the name of a temporary file containing the contents of
888the file on the current branch; 'REMOTE' is the name of a temporary
889file containing the contents of the file from the branch being
890merged; 'MERGED' contains the name of the file to which the merge
891tool should write the results of a successful merge.
892
893mergetool.<tool>.trustExitCode::
894For a custom merge command, specify whether the exit code of
895the merge command can be used to determine whether the merge was
896successful. If this is not set to true then the merge target file
897timestamp is checked and the merge assumed to have been successful
898if the file has been updated, otherwise the user is prompted to
899indicate the success of the merge.
900
901mergetool.keepBackup::
902After performing a merge, the original file with conflict markers
903can be saved as a file with a `.orig` extension. If this variable
904is set to `false` then this file is not preserved. Defaults to
905`true` (i.e. keep the backup files).
906
Junio C Hamano75cc4c92006-07-24 08:25:03907pack.window::
Junio C Hamano35738e82008-01-07 07:55:46908The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:03909window size is given on the command line. Defaults to 10.
910
Junio C Hamano91d44c52007-05-09 07:16:07911pack.depth::
Junio C Hamano35738e82008-01-07 07:55:46912The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:07913maximum depth is given on the command line. Defaults to 50.
914
Junio C Hamano235d53f2007-07-13 00:25:15915pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:46916The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:15917when no limit is given on the command line. The value can be
918suffixed with "k", "m", or "g". Defaults to 0, meaning no
919limit.
920
Junio C Hamanof2ce2972007-05-20 19:12:09921pack.compression::
922An integer -1..9, indicating the compression level for objects
923in a pack file. -1 is the zlib default. 0 means no
924compression, and 1..9 are various speed/size tradeoffs, 9 being
925slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42926not set, defaults to -1, the zlib default, which is "a default
927compromise between speed and compression (currently equivalent
928to level 6)."
Junio C Hamanof2ce2972007-05-20 19:12:09929
Junio C Hamano679d22d2007-06-02 21:13:44930pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:27931The maximum memory in bytes used for caching deltas in
Junio C Hamano35738e82008-01-07 07:55:46932linkgit:git-pack-objects[1].
Junio C Hamano679d22d2007-06-02 21:13:44933A value of 0 means no limit. Defaults to 0.
934
935pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:14936The maximum size of a delta, that is cached in
Junio C Hamano35738e82008-01-07 07:55:46937linkgit:git-pack-objects[1]. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:44938
Junio C Hamano58155b42007-09-15 07:46:14939pack.threads::
940Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:46941delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:14942be compiled with pthreads otherwise this option is ignored with a
943warning. This is meant to reduce packing time on multiprocessor
944machines. The required amount of memory for the delta search window
945is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:44946Specifying 0 will cause git to auto-detect the number of CPU's
947and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:14948
Junio C Hamanod814b6d2007-11-04 11:13:49949pack.indexVersion::
950Specify the default pack index version. Valid values are 1 for
951legacy pack index used by Git versions prior to 1.5.2, and 2 for
952the new pack index with capabilities for packs larger than 4 GB
953as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:38954packs. Version 2 is the default. Note that version 2 is enforced
955and this config option ignored whenever the corresponding pack is
956larger than 2 GB.
957+
958If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
959cloning or fetching over a non native protocol (e.g. "http" and "rsync")
960that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
961other side may give you a repository that cannot be accessed with your
962older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
963you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
964the `{asterisk}.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:49965
Junio C Hamano09a926d2008-03-13 07:55:29966pack.packSizeLimit::
Junio C Hamano49dccaf2008-02-10 10:48:01967The default maximum size of a pack. This setting only affects
968packing to a file, i.e. the git:// protocol is unaffected. It
969can be overridden by the `\--max-pack-size` option of
970linkgit:git-repack[1].
971
Junio C Hamano07824ce2006-04-25 07:36:54972pull.octopus::
973The default merge strategy to use when pulling multiple branches
974at once.
975
976pull.twohead::
977The default merge strategy to use when pulling a single branch.
978
Junio C Hamano249572f2006-10-24 05:44:08979remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:46980The URL of a remote repository. See linkgit:git-fetch[1] or
981linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:08982
Junio C Hamano58256872007-12-04 08:31:13983remote.<name>.proxy::
984For remotes that require curl (http, https and ftp), the URL to
985the proxy to use for that remote. Set to the empty string to
986disable proxying for that remote.
987
Junio C Hamano249572f2006-10-24 05:44:08988remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:46989The default set of "refspec" for linkgit:git-fetch[1]. See
990linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:08991
992remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:46993The default set of "refspec" for linkgit:git-push[1]. See
994linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:08995
Junio C Hamano47d68a52008-05-06 06:35:40996remote.<name>.mirror::
997If true, pushing to this remote will automatically behave
998as if the `\--mirror` option was given on the command line.
999
Junio C Hamano118d2772007-02-21 20:24:101000remote.<name>.skipDefaultUpdate::
1001If true, this remote will be skipped by default when updating
Junio C Hamano35738e82008-01-07 07:55:461002using the update subcommand of linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101003
Junio C Hamano4ad294b2007-01-20 02:22:501004remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481005The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551006option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501007
Junio C Hamano54ea8d32007-01-25 07:59:481008remote.<name>.uploadpack::
1009The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551010option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481011
Junio C Hamano17dde0e2007-02-26 09:50:211012remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551013Setting this value to \--no-tags disables automatic tag following when
1014fetching from remote <name>
Junio C Hamano17dde0e2007-02-26 09:50:211015
Junio C Hamano118d2772007-02-21 20:24:101016remotes.<group>::
1017The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461018<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101019
Junio C Hamano77b7e902006-10-23 07:18:501020repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381021By default, linkgit:git-repack[1] creates packs that use
1022delta-base offset. If you need to share your repository with
1023git older than version 1.4.4, either directly or via a dumb
1024protocol such as http, then you need to set this option to
1025"false" and repack. Access from old git versions over the
1026native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501027
Junio C Hamano07824ce2006-04-25 07:36:541028showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461029The default set of branches for linkgit:git-show-branch[1].
1030See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541031
Junio C Hamano942b35e2007-12-09 10:19:331032status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461033By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331034current directory. Setting this variable to `false` shows paths
1035relative to the repository root (this was the default for git
1036prior to v1.5.4).
1037
Junio C Hamano4224f992008-06-23 07:14:081038status.showUntrackedFiles::
1039By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1040files which are not currently tracked by Git. Directories which
1041contain only untracked files, are shown with the directory name
1042only. Showing untracked files means that Git needs to lstat() all
1043all the files in the whole repository, which might be slow on some
1044systems. So, this variable controls how the commands displays
1045the untracked files. Possible values are:
1046+
1047--
1048- 'no' - Show no untracked files
1049- 'normal' - Shows untracked files and directories
1050- 'all' - Shows also individual files in untracked directories.
1051--
1052+
1053If this variable is not specified, it defaults to 'normal'.
1054This variable can be overridden with the -u|--untracked-files option
1055of linkgit:git-status[1] and linkgit:git-commit[1].
1056
Junio C Hamano75cc4c92006-07-24 08:25:031057tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:091058This variable can be used to restrict the permission bits of
1059tar archive entries. The default is 0002, which turns off the
1060world write bit. The special value "user" indicates that the
1061archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:461062linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:031063
Junio C Hamano24bc09a2008-02-28 00:27:441064url.<base>.insteadOf::
1065Any URL that starts with this value will be rewritten to
1066start, instead, with <base>. In cases where some site serves a
1067large number of repositories, and serves them with multiple
1068access methods, and some users need to use different access
1069methods, this feature allows people to specify any of the
1070equivalent URLs and have git automatically rewrite the URL to
1071the best alternative for the particular user, even for a
1072never-before-seen repository on the site. When more than one
1073insteadOf strings match a given URL, the longest match is used.
1074
Junio C Hamano07824ce2006-04-25 07:36:541075user.email::
1076Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:341077Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:461078'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541079
1080user.name::
1081Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:481082Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:461083environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541084
Junio C Hamanoa890c4f2007-01-28 10:29:211085user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:461086If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:211087automatically when creating a signed tag, you can override the
1088default selection with this variable. This option is passed
1089unchanged to gpg's --local-user parameter, so you may specify a key
1090using any method that gpg supports.
1091
Junio C Hamano07824ce2006-04-25 07:36:541092imap::
1093The configuration variables in the 'imap' section are described
Junio C Hamano35738e82008-01-07 07:55:461094in linkgit:git-imap-send[1].
Junio C Hamano459ee222006-09-21 08:13:281095
Junio C Hamanob78d2592008-04-09 09:39:081096receive.fsckObjects::
1097If it is set to true, git-receive-pack will check all received
1098objects. It will abort in the case of a malformed object or a
1099broken link. The result of an abort are only dangling objects.
1100Defaults to false.
1101
Junio C Hamano0d3c8152006-11-08 01:33:411102receive.unpackLimit::
1103If the number of objects received in a push is below this
1104limit then the objects will be unpacked into loose object
1105files. However if the number of received objects equals or
1106exceeds this limit then the received pack will be stored as
1107a pack, after adding any missing delta bases. Storing the
1108pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171109especially on slow filesystems. If not set, the value of
1110`transfer.unpackLimit` is used instead.
Junio C Hamano0d3c8152006-11-08 01:33:411111
1112receive.denyNonFastForwards::
Junio C Hamano459ee222006-09-21 08:13:281113If set to true, git-receive-pack will deny a ref update which is
1114not a fast forward. Use this to prevent such an update via a push,
1115even if that push is forced. This configuration variable is
1116set when initializing a shared repository.
1117
Junio C Hamano54ea8d32007-01-25 07:59:481118transfer.unpackLimit::
1119When `fetch.unpackLimit` or `receive.unpackLimit` are
1120not set, the value of this variable is used instead.
Junio C Hamanoe77b0152008-01-12 06:44:171121The default value is 100.
Junio C Hamano4e272312008-01-08 09:13:211122
1123web.browser::
1124Specify a web browser that may be used by some commands.
1125Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1126may use it.